<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>hwicap_v11_6: xhwicap_read_frame_polled_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">hwicap_v11_6
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xhwicap__read__frame__polled__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xhwicap_read_frame_polled_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>The is example shows how to use the <a class="el" href="group__hwicap.html#gafdb7b9947a1e1610a214814c1b19a0a1" title="Reads one frame from the device and puts it in memory specified by the user. ">XHwIcap_DeviceReadFrame()</a> to read a frame of data. </p>
<p>This example simply reads one frame from the device using the polled mode.</p>
<p>This example assumes that there is a UART Device or STDIO Device in the hardware system.</p>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>This example should run on any Virtex4 or Virtex5 or Virtex6 or Spartan6 or Kintex 7 device.</p>
<pre></pre><pre>MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.00a bjb  11/21/03 First release
1.00a sv   07/18/05 Minor changes to comply to Doxygen and coding guidelines
1.01a sv   04/10/07 Changes to support V4
2.00a sv   10/04/07 Changes to support FIFO mode
4.00a hvm  11/20/09 Updated to support V6
5.00a hvm  2/20/10  Updated to support S6.
6.00a hvm  08/05/11 Added support for K7 family
10.0  bss  6/24/14  Removed support for families older than 7 series
11.6  Nava 06/28/23 Added support for system device-tree flow.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa60b2d782acf4fcd0561a584cd4606e5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap__read__frame__polled__example_8c.html#aa60b2d782acf4fcd0561a584cd4606e5">HwIcapReadFramePolledExample</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:aa60b2d782acf4fcd0561a584cd4606e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads a frame from the device as an example using polled mode.  <a href="#aa60b2d782acf4fcd0561a584cd4606e5">More...</a><br/></td></tr>
<tr class="separator:aa60b2d782acf4fcd0561a584cd4606e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xhwicap__read__frame__polled__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the HwIcap Frame example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aa60b2d782acf4fcd0561a584cd4606e5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int HwIcapReadFramePolledExample </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads a frame from the device as an example using polled mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the XPAR_&lt;HWICAP_INSTANCE&gt;_DEVICE_ID value from xparameters.h</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_hw_icap___config.html#a6be849d17f51b639414cae9620f2dcd5">XHwIcap_Config::BaseAddress</a>, <a class="el" href="struct_x_hw_icap.html#a3f9285b94c87fa0052336a7fdeb75bf4">XHwIcap::WordsPerFrame</a>, <a class="el" href="group__hwicap.html#gad497b5129aff666181e85457f1c5f678">XHwIcap_CfgInitialize()</a>, <a class="el" href="group__hwicap.html#gafdb7b9947a1e1610a214814c1b19a0a1">XHwIcap_DeviceReadFrame()</a>, <a class="el" href="group__hwicap.html#gadead7aef30c83eb98380b986884b0e6f">XHwIcap_LookupConfig()</a>, and <a class="el" href="group__hwicap.html#ga0716d6a3c65aabb73344bee9c4c9cfc7">XHwIcap_SelfTest()</a>.</p>

<p>Referenced by <a class="el" href="xhwicap__read__frame__polled__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the HwIcap Frame example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, XST_FAILURE if unsuccessful</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="xhwicap__read__frame__polled__example_8c.html#aa60b2d782acf4fcd0561a584cd4606e5">HwIcapReadFramePolledExample()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
